/*
 * Copyright (c) 2025 Oracle and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.helidon.builder.codegen;

import java.util.Optional;

import io.helidon.builder.api.Option;
import io.helidon.builder.api.Prototype;
import io.helidon.common.types.AccessModifier;

/**
 * Configuration information for a prototype.
 */
@Prototype.Blueprint(detach = true)
interface PrototypeConfiguredBlueprint {
    /**
     * Access modifier.
     *
     * @return access modifier of the method {@code create(Config)}, defaults to {@code public}
     */
    @Option.Default("PUBLIC")
    AccessModifier createAccessModifier();

    /**
     * Whether the configuration is expected from the root of config tree.
     * Defaults to {@code true} in case a {@link #key()} is defined.
     *
     * @return whether this prototype uses root configuration key
     */
    @Option.Default("true")
    boolean root();

    /**
     * Key of this prototype's configuration.
     *
     * @return key if configured
     */
    Optional<String> key();
}
